Referência técnica

Links oficiais

Recurso	URL	Uso
Swagger (interativo)	api-public.makepro.com.br/api/docs	Explorar e testar endpoints no navegador
OpenAPI JSON	api-public.makepro.com.br/api/openapi.json	Gerar clientes, importar no Postman/Insomnia
Base da API	https://api-public.makepro.com.br/api/v1	Prefixo de todas as rotas

Convenções

• Métodos: quase toda a superfície é GET. Escritas usam POST nos domínios liberados (reuniões, diretrizes, classificação de documento). Não há PUT, PATCH ou DELETE.
• Rotas de projeto: existem em forma curta (/projects/{pid}/...) e longa (/companies/{cid}/projects/{pid}/...). Prefira a curta, exceto no cronograma.
• Paginação: listagens usam cursor; consulte o Swagger para cursor, limit e formato de items.
• Erros: respostas 401, 403, 404 e 429 trazem código estruturado no corpo. Veja o Swagger para o schema de cada domínio.

Integrar com ferramentas

Postman / Insomnia

1. Importe https://api-public.makepro.com.br/api/openapi.json
2. Configure variável de ambiente API_KEY com sua chave mkp_...
3. No header global: Authorization: Bearer {{API_KEY}}

Gerar cliente (OpenAPI Generator)

curl -s https://api-public.makepro.com.br/api/openapi.json -o openapi.json

# Exemplo: cliente Python
openapi-generator generate -i openapi.json -g python -o ./makepro-client

Documentação narrativa vs Swagger

Esta seção da Central de Ajuda explica conceitos, fluxos e armadilhas. O Swagger descreve cada parâmetro e schema da instalação atual.

Pergunta	Onde buscar
"Por onde começo?"	Primeiros passos
"Como obtenho a chave?"	Autenticação e chaves
"Qual o tipo do campo X?"	Swagger
"Existe endpoint Y?"	OpenAPI JSON